Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

IBX-8597: Added BaseSortClauseProcessor #117

Merged
merged 4 commits into from
Sep 4, 2024
Merged

IBX-8597: Added BaseSortClauseProcessor #117

merged 4 commits into from
Sep 4, 2024

Conversation

ciastektk
Copy link
Contributor

@ciastektk ciastektk commented Jul 19, 2024 •
edited
Loading

@ciastektk ciastektk force-pushed the ibx-8597-added-base-sort-clause-processor branch from e622a5a to da66dfb Compare July 19, 2024 07:43
@ciastektk ciastektk requested a review from a team July 19, 2024 08:27
@konradoboza konradoboza requested a review from a team July 19, 2024 08:47
alongosz
alongosz reviewed Jul 19, 2024
View reviewed changes
Copy link
Member

@alongosz alongosz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the use case? Sorry, didn't catch that during the internal sync.

@ciastektk
Copy link
Contributor Author

ciastektk commented Jul 19, 2024 •
edited
Loading

What is the use case? Sorry, didn't catch that during the internal sync.

The use case is to avoid duplicating code to process criteria or sort clauses by media type.

Criteria

SortClauses

@ciastektk ciastektk requested review from alongosz and a team July 19, 2024 12:38
@alongosz
Copy link
Member

@ciastektk so how you're planning to utilize that feature? Could you give an example of changes for any of the mentioned duplications? I'm just not 100% sure base class in this case is the best choice. Unsure without an example.

@ciastektk
Copy link
Contributor Author

@alongosz:

https://github.com/ibexa/shipping/pull/77
https://github.com/ibexa/product-catalog/pull/1171

@ciastektk ciastektk force-pushed the ibx-8597-added-base-sort-clause-processor branch from da66dfb to 5967b12 Compare August 7, 2024 07:00
@ciastektk ciastektk requested review from Steveb-p and a team August 7, 2024 07:04
@ciastektk ciastektk force-pushed the added-criterion-processor branch from 4d881b8 to 9d8d85c Compare August 7, 2024 11:04
@ciastektk ciastektk force-pushed the ibx-8597-added-base-sort-clause-processor branch from 899ab2b to 9e136f5 Compare August 7, 2024 11:05
alongosz
alongosz approved these changes Aug 20, 2024
View reviewed changes
Copy link
Member

@alongosz alongosz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coming a bit late to the party. Overall +1 as the other idea I had for this issue is not well shaped even in my head and you have a working solution already ;)

What I'm missing here is some unit test coverage of that SPI (yes, it's an SPI :D ).
The implementation is "dangling", meaning that there's no actual usage in this package, thus it's not stable. What you need to do is add some stub coverage for that abstract. Happy path is enough for now.

src/contracts/Input/Parser/Query/SortClause/BaseSortClauseProcessor.php Outdated
Comment on lines 53 to 55
abstract protected function getMediaTypePrefix(): string;

abstract protected function getParserInvalidSortClauseMessage(string $sortClauseName): string;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CS: I'd probably move it even above constructor, so it's visible on the top for any consumer of that SPI. Or if you want to keep visibility precedence, then it should be at least above that private method.

Base automatically changed from added-criterion-processor to 4.6 August 20, 2024 12:04
@ciastektk ciastektk force-pushed the ibx-8597-added-base-sort-clause-processor branch from 9e136f5 to 65215fb Compare August 20, 2024 13:26
@tomaszszopinski tomaszszopinski self-assigned this Aug 21, 2024
@ciastektk ciastektk force-pushed the ibx-8597-added-base-sort-clause-processor branch from 65215fb to 177ab67 Compare August 30, 2024 06:38
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

tomaszszopinski
tomaszszopinski approved these changes Sep 4, 2024
View reviewed changes
Copy link

@tomaszszopinski tomaszszopinski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

QA approved on IbexaDXP 4.6 commerce.

@Steveb-p Steveb-p merged commit e2b32ed into 4.6 Sep 4, 2024
11 checks passed
@Steveb-p Steveb-p deleted the ibx-8597-added-base-sort-clause-processor branch September 4, 2024 07:40
@Steveb-p
Copy link
Contributor

Steveb-p commented Sep 4, 2024

Merged up into main in 42df177.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tomaszszopinski tomaszszopinski tomaszszopinski approved these changes

@konradoboza konradoboza konradoboza approved these changes

@alongosz alongosz alongosz approved these changes

@adamwojs adamwojs adamwojs approved these changes

@Steveb-p Steveb-p Awaiting requested review from Steveb-p

Assignees

@Steveb-p Steveb-p

@alongosz alongosz

@tischsoic tischsoic

@tomaszszopinski tomaszszopinski

Labels
Improvement QA approved
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@ciastektk @alongosz @Steveb-p @adamwojs @konradoboza @tomaszszopinski @tischsoic